Skip to content

Conversation

@jcjaskula-aws
Copy link
Contributor

Issue #, if available:

A cheat sheet is a good way to browse the BDK API to find quickly which functions to use.

Description of changes:

This PR:

  • adds the source for a cheat sheet based on jekyll.
  • adds a CI action that build and publish the cheat sheet on github pages
  • adds a script that goes through all the sections of the cheat sheet and create a single markdown file to feed genAI agent
    • it uses html comments to optimize the cheat sheet (adding additional information that we might not want to publish in the cheat sheet to keep it clean)
    • it adds the markdown file at the root of the website and can be vended via url/genAI_optimized_cheat_sheet.md

Testing done:

N/A

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov
Copy link

codecov bot commented Jun 5, 2024

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a76c4e2) to head (2a0f489).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #995   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          162       162           
  Lines        10450     10450           
  Branches      1296      1296           
=========================================
  Hits         10450     10450           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rmshaffer rmshaffer self-assigned this Jun 5, 2024
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a condition to skip the deployment if it is a pull-request: if: github.event_name != 'pull_request'?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is configured to only run after a push to main - I think this would automatically exclude pull requests?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see, it can be manually executed. Yes, that should be fixed, thanks for catching that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It ran automatically the first time too. Wonder if it because it targets main.

@rmshaffer rmshaffer mentioned this pull request Jun 28, 2024
5 tasks
@rmshaffer rmshaffer removed their assignment Oct 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants